Skip to content

feat: Add kroki plugin to support PlantUML diagrams #790

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Closed
wants to merge 1 commit into from
Closed

feat: Add kroki plugin to support PlantUML diagrams #790

wants to merge 1 commit into from

Conversation

@sbernauer
Copy link
Member

@sbernauer sbernauer commented Oct 31, 2025 •
edited by NickLarsenNZ
Loading

Used in https://github.com/stackabletech/listener-operator/pull/348/files

To render procedures like:

[plantuml, svg]
....
@startuml
if (LoadBalancers supported?) is (yes) then
  #palegreen:Use ephermal-nodes;
  kill
else (no)
  if (Nodes regularly rotated?) is (yes) then
    #yellow:Use stable-nodes to prefer NodePort
    over LoadBalancers. However, don't use
    the external-stable ListenerClass at all,
    use external-unstable instead;
    kill
  else (no)
    #palegreen:Use stable-nodes;
    kill
endif
@enduml
....

@netlify
Copy link

netlify bot commented Oct 31, 2025 •
edited
Loading

❌ Deploy Preview for stackable-docs failed.

Name Link
🔨 Latest commit 696a6e7
🔍 Latest deploy log https://app.netlify.com/projects/stackable-docs/deploys/690465eef648710008050561

@sbernauer sbernauer self-assigned this Oct 31, 2025
@sbernauer sbernauer moved this to Development: Waiting for Review in Stackable Engineering Oct 31, 2025
@sbernauer sbernauer mentioned this pull request Oct 31, 2025
Merged
@sbernauer sbernauer closed this Oct 31, 2025
@sbernauer sbernauer reopened this Oct 31, 2025
@NickLarsenNZ
Copy link
Member

NickLarsenNZ commented Oct 31, 2025

Is there a mermaid plugin?

@NickLarsenNZ
Copy link
Member

NickLarsenNZ commented Oct 31, 2025

I see https://github.com/snt/antora-mermaid-extension

NickLarsenNZ
NickLarsenNZ requested changes Oct 31, 2025
View reviewed changes
Copy link
Member

@NickLarsenNZ NickLarsenNZ left a comment •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Could we please use mermaid instead?
I mentioned it in the slack thread. It is maintained (maybe PlantUML is again) and has better diagrams.

@NickLarsenNZ
Copy link
Member

NickLarsenNZ commented Nov 3, 2025

After seeing the usage, I think this is easier in plantuml (this would have been perfect info for the empty description).

I will move to approve.

@NickLarsenNZ
Copy link
Member

NickLarsenNZ commented Nov 3, 2025

I have updated the description.

NickLarsenNZ
NickLarsenNZ approved these changes Nov 3, 2025
View reviewed changes
Copy link
Member

@NickLarsenNZ NickLarsenNZ left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM (after seeing the usage)

@NickLarsenNZ NickLarsenNZ moved this from Development: Waiting for Review to Development: In Review in Stackable Engineering Nov 3, 2025
@sbernauer sbernauer mentioned this pull request Nov 3, 2025
Merged
@sbernauer
Copy link
Member Author

sbernauer commented Nov 3, 2025

Replaced by #791, as we had problems with Kroki in the past (search for PRs with kroki)

@sbernauer sbernauer closed this Nov 3, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@NickLarsenNZ NickLarsenNZ NickLarsenNZ approved these changes

Assignees

@sbernauer sbernauer

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@sbernauer @NickLarsenNZ